/*
 * Copyright (C) 2021 Bosch.IO GmbH
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * SPDX-License-Identifier: Apache-2.0
 * License-Filename: LICENSE
 */

package org.ossreviewtoolkit.clients.fossid.model.status

/**
 * An interface abstracting a Scan description, regardless of the version of the FossID server.
 */
interface UnversionedScanDescription {
    /**
     * The current status of the scan.
     */
    val status: ScanStatus

    /**
     * A comment provideing extra information (set when the scan is in status [ScanStatus.FINISHED]).
     */
    val comment: String?
}
